Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Method to import checks from any known extensions #447

Draft
wants to merge 5 commits into
base: dev
Choose a base branch
from

Conversation

CodyCBakerPhD
Copy link
Contributor

Motivation

One idea for removing the need to use --modules ndx_multichannel_volume every time

cc @dysprague - can you tell us if this works on your example? (you will probably have to do pip install git+https://github.com/neurodatawithoutborders/nwbinspector.git@search_for_extension_checks

@CodyCBakerPhD CodyCBakerPhD self-assigned this Apr 19, 2024
@CodyCBakerPhD
Copy link
Contributor Author

From the discussion, we will go for a semi-automated opt-in only approach handled via config files

User trusted extensions would be registered via

nwbinspector register ndx-multichannel-volume

which would add that extension name to the config file such that any subsequent calls would automatically import that module, triggered the import of associated registered checks, without having to call --modules ndx-multichannel-volume explicitly every single time

@bendichter
Copy link
Contributor

We also might want to add nwbinspector unregister and nwbinspector list

@CodyCBakerPhD CodyCBakerPhD marked this pull request as draft May 3, 2024 14:22
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 87.11%. Comparing base (fe276f8) to head (f47019c).

Files Patch % Lines
src/nwbinspector/__init__.py 80.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##              dev     #447      +/-   ##
==========================================
- Coverage   87.14%   87.11%   -0.03%     
==========================================
  Files          23       23              
  Lines        1260     1265       +5     
==========================================
+ Hits         1098     1102       +4     
- Misses        162      163       +1     
Flag Coverage Δ
unittests 87.11% <80.00%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/nwbinspector/__init__.py 95.23% <80.00%> (-4.77%) ⬇️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants